<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Maven Download Plugin - download:artifact</title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
      </head>
  <body class="composite">
    <div id="banner">
                    <span id="bannerLeft">
    
            Maven Download Plugin
    
            </span>
                    <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
  
  
    
            <div class="xleft">
        Last Published: 2009-05-12
                      </div>
            <div class="xright">      
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
  
  
    
                   <h5>Overview</h5>
            <ul>
              
    <li class="none">
                    <a href="index.html">Introduction</a>
          </li>
              
    <li class="none">
                    <a href="plugin-info.html">Goals</a>
          </li>
              
    <li class="none">
                    <a href="usage.html">Usage</a>
          </li>
              
    <li class="none">
                    <a href="faq.html">FAQ</a>
          </li>
          </ul>
              <h5>Examples</h5>
            <ul>
              
    <li class="none">
                    <a href="examples/artifact_no_pom.html">Downloading standalone artifact</a>
          </li>
          </ul>
              <h5>Project Documentation</h5>
            <ul>
              
    <li class="none">
                    <a href="project-info.html">ProjectInformation</a>
          </li>
              
    <li class="none">
                    <a href="project-reports.html">Project Reports</a>
          </li>
          </ul>
                                           <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
  
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <div class="section"><h2><a name="download:artifact"></a>download:artifact</h2>
<p><strong>Full name</strong>:</p>
<p>com.googlecode:maven-download-plugin:0.2-SNAPSHOT:artifact</p>
<p><strong>Description</strong>:</p>
<div>This mojo is designed to download a maven artifact from the
repository and download them in the specified path. The maven
artifact downloaded can also download it's dependency or not, based
on a parameter.</div><p><strong>Attributes</strong>:</p>
<ul><li>Binds by default to the lifecycle phase: <code>process-resources</code>.</li>
</ul>
<div class="section"><h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#artifactId">artifactId</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>The artifact Id of the file to download.<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#groupId">groupId</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>The group Id of the file to download.<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#version">version</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>The version of the file to download.<br />
</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#classifier">classifier</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>The classifier of artifact to download.<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#dependencyDepth">dependencyDepth</a></strong></td>
<td><code>long</code></td>
<td><code>-</code></td>
<td>The dependency depth to query. Will try to fetch the artifact for
as much as the number of dependency specified.<br />
<strong>Default value is</strong>: <code>0</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#localRepository">localRepository</a></strong></td>
<td><code>ArtifactRepository</code></td>
<td><code>-</code></td>
<td>(no description)<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#outputDirectory">outputDirectory</a></strong></td>
<td><code>File</code></td>
<td><code>-</code></td>
<td>Location of the file.<br />
<strong>Default value is</strong>: <code>${project.build.directory}</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#remoteRepositories">remoteRepositories</a></strong></td>
<td><code>List</code></td>
<td><code>-</code></td>
<td>(no description)<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#type">type</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>The type of artifact to download.<br />
<strong>Default value is</strong>: <code>jar</code>.</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><strong><a name="artifactId">artifactId</a>:</strong></p>
<div>The artifact Id of the file to download.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${artifactId}</code></li>
</ul>
<hr />
<p><strong><a name="classifier">classifier</a>:</strong></p>
<div>The classifier of artifact to download.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${classifier}</code></li>
</ul>
<hr />
<p><strong><a name="dependencyDepth">dependencyDepth</a>:</strong></p>
<div>The dependency depth to query. Will try to fetch the artifact for
as much as the number of dependency specified.</div><ul><li><strong>Type</strong>: <code>long</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${dependencyDepth}</code></li>
<li><strong>Default</strong>: <code>0</code></li>
</ul>
<hr />
<p><strong><a name="groupId">groupId</a>:</strong></p>
<div>The group Id of the file to download.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${groupId}</code></li>
</ul>
<hr />
<p><strong><a name="localRepository">localRepository</a>:</strong></p>
<div>(no description)</div><ul><li><strong>Type</strong>: <code>org.apache.maven.artifact.repository.ArtifactRepository</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${localRepository}</code></li>
</ul>
<hr />
<p><strong><a name="outputDirectory">outputDirectory</a>:</strong></p>
<div>Location of the file.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${outputDirectory}</code></li>
<li><strong>Default</strong>: <code>${project.build.directory}</code></li>
</ul>
<hr />
<p><strong><a name="remoteRepositories">remoteRepositories</a>:</strong></p>
<div>(no description)</div><ul><li><strong>Type</strong>: <code>java.util.List</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${project.remoteArtifactRepositories}</code></li>
</ul>
<hr />
<p><strong><a name="type">type</a>:</strong></p>
<div>The type of artifact to download.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${type}</code></li>
<li><strong>Default</strong>: <code>jar</code></li>
</ul>
<hr />
<p><strong><a name="version">version</a>:</strong></p>
<div>The version of the file to download.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${version}</code></li>
</ul>
</div>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2009
    
          Independant
          
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
